1.1. Scope
This document provides an overview of the CMP 8.21 release with specific focus on the additional functional and non-functional enhancements with respect to CMP 8.20.
1.2. Audience
This document is aimed at internal and external audiences familiar with CMP, to explain the key features of the release including any changes in how existing functions or processes are working.
2.1. New Functionality
CMP 8.21 introduces the following new functionality. Each item below is summarised at a high level; refer to the
relevant sections in Section 3 for full detail.
2.1.1. AgentView – Customer Structure: Enhanced Serial Number Search
Customer Structure in AgentView has been enhanced to improve usability when working with accounts containing a
large number of subscriptions. Agents can now perform a full search on the primary serial number and build a
dynamic list of subscriptions before applying actions from the right-click menu.
This reduces the need for manual scrolling, makes multi-selection clearer, and helps prevent errors by allowing
agents to review their selection prior to applying actions. For further details, see Section 3.1.1.
2.1.2. Administration Console - Serial Number Management
A new Number Management option has been added to the Administration Console to support generation and maintenance of managed serial numbers,
including allocating, deallocating, deleting and resetting of serial numbers, with an integrated error view. See Section 3.3.1 for details.
2.1.3. Business Configuration – Network Serial Numbers: Prefix/List Maintenance
Configuration Centre has been enhanced to allow prefix and list values to be added
and maintained for network serial numbers via a new Prefixes/List option. For full detail, see Section 3.4.1.
2.1.4. Licensing Server
This CMP release introduces a Licensing Server which drives the modules and components that are installed.
This allows the required components to be selected (including mandatory and optional modules), and a licence key to be generated for use during installation.
The next release of CMP will enhance the server functionality further
by controlling access to modules and components in real-time.
As part of this change, the Installation Configuration Tool (ICT) has been updated to accept the location of the generated
.p12 certificate (on the Ansible control node) and the associated keystore password, which are required during deployment.
For deployment details and ICT configuration requirements, see Section 6.2.1.
2.2. Changed Functionality
CMP 8.21 includes the following changes to existing functionality. Each item below is summarised at a high level;
refer to the relevant sections in Section 3 for full detail.
2.2.1. AgentView – Orders: Product Catalogue Integration
The AgentView order panels have been refactored to integrate further with the Product Catalogue.
As part of this change, product selection is now based on product offerings, with bundles represented as
bundled product offerings, removing the dependency on product items within the order panels.
The products mini/bottom panels have been replaced with new product offering panels, the order header pricing now calculates
from product offering pricing, and the order status actions have been simplified. For full details, see Section 3.1.2.
2.2.2. Administration Console – Network Requests: Manual update for stuck network actions
The Network Requests list view has been enhanced to allow back-office users to manually update network actions that are stuck in a pending
status. This provides a controlled alternative to manual database updates and allows the subscription to be
released from “activity pending” so actions can be retried if required. See Section 3.3.2 for details.
3.1. AgentView
3.1.1. Customer Structure – Serial Number Search and Selection List
The Customer Structure screen in AgentView has been enhanced to make it easier to locate and work with subscriptions in large hierarchies.
Agents can now search by the primary serial number and build a list of subscriptions before applying actions.
- A new search component is available at the top right of the Customer Structure panel allowing users to search the structure using serial number id 1.
- Matched subscriptions are highlighted in the hierarchy and automatically added to the scrollable selection list.
- Subscriptions selected directly in the hierarchy (including multi-selected subscriptions using CTRL) are also added to the selection list.
- The selection list supports clearing individual entries or clearing the full list, and is reset when leaving the Customer Structure.
- Right-click actions can be applied to the selected subscriptions once the selection is completed and has been reviewed; options that require a single selection remain disabled when multiple subscriptions are selected.
3.1.2. Orders – Product Catalogue Integration (Product Offerings)
The AgentView order panels have been refactored to integrate further with the Product Catalogue. Ordering and display of
ordered items is now based on product offerings, with bundles represented as bundled product offerings.
Product offering panels
The existing products mini and bottom panels have been replaced with new product offering panels. These panels provide a
consistent view of the product offering the order was for, and include a single right-click option: View which displays further details of the product
offering and any product offering attributes.
- Mini panel shows: Product Offering Name, Quantity, Offering Price, Upfront Price, Instalment Price.
- Bottom panel shows: Offering Id, Product Offering Name, Type of Product, Quantity, Offering Price, Contract Term, Upfront Price, Instalment Price, Bundle.
Order header updates
- The gross price on the order header panel is calculated based on product offering pricing.
-
The order status hyperlink options have been simplified to:
Cancel Order and Resubmit Order.
Order comments panel improvements
The order comments panel has been improved to ensure no unnecessary text wrapping when entering and viewing order comments.
3.2. Bulk Actions
There are no new or changed Bulk Actions as part of this release.
3.3. Administration Console
3.3.1. Serial Number Management
The Administration Console has been enhanced with a new Number Management option to support additional managed serial number maintenance operations.
This complements the existing managed number processing by providing user-driven actions such as loading ranges of serial numbers, that are then executed via the managed number load job.
- Generate Serial Numbers - create sequential serial numbers for a selected network and serial number id, with optional reservation and allocation details.
- Manage Serial Numbers - search and select serial numbers, then perform bulk actions:
- Allocate (to a salesperson or account)
- Deallocate (back to not allocated)
- Delete (physical delete from serial number management)
- Reset (from selecting/cooling off/expired back to an allocatable state)
- View Serial Number Errors - view errors produced during serial number management activity and filter by network, serial number id and full/partial serial number.
All load and update activity is processed through the managed number load job, which has been refactored to support the additional execution paths
(load, allocate, deallocate, delete and reset) and to record validation errors where requests are not compatible with the current management status.
3.3.2. Network Requests – Update Network Action Manually
A new Update option has been added to the Network Requests Log list view to support resolution of actions that are
stuck at a status of 'Sent to Network'. This provides a controlled alternative to manual database updates by allowing an
operator to progress the underlying action to an error outcome so the subscription is no longer blocked.
In practice, an operator will have the affected subscription number as well as the Actioned Item Number and the action type (all available in AgentView
during initial troubleshooting). The subscription number can be used to search and locate the relevant Network Requests Log entries in the Network Requests list.
The action type is also shown in the list view, allowing the operator to narrow the results to the specific action that is stuck.
- The Subscription column has been moved to the start of the list view.
- The subscription number search component has been repositioned above the Subscription column.
-
The Update button is only available for unprocessed Network Requests where the underlying actioned item
is in Sent to Network status. Selecting Update allows the operator to enter a comment; confirming the panel then
creates a record in the Confirm Action Item Request table.
The Action Monitor job automatically processes this request and updates the relevant event and action statuses, allowing the
subscription to be released from “activity pending” and enabling actions to be retried if required.
3.3.3. Serial Number Management – Management Status Label Update
The management status description Allocated to Dealer has been renamed to Allocated to Salesperson.
This change applies wherever serial number management statuses are displayed.
3.4. Aurora Console
3.4.1. Auto Timeout
An auto timeout capability has been implemented for the Aurora Console, aligning session behaviour with other CMP consoles.
The timeout value matches the configuration used by the Administration Console.
3.5. Business Configuration
3.5.1. Network Serial Numbers – Prefix/List Maintenance
New functionality has been introduced in Business Configuration to allow prefix or list values to be added and
maintained for serial numbers.
Note: Prefixes can be defined for both managed and non-managed numbers, but list values can only be defined for
non-managed numbers.
-
A new Prefixes/List button is available on the Network Serial Numbers list view.
Selecting this opens a list view with the following columns:
- Value (prefix or list value)
- Description
- Type (Prefix / List / None)
- Min Length
- Max Length
-
The Prefixes/List list view supports Add, Edit, and Delete.
-
For non-managed numbers, the ability to define prefix/list values is controlled by the
Validation Type of the non-managed number (i.e. Prefix or List).
If Validation Type is set to None, an error message is displayed if the user selects Prefixes/List.
3.5.2. Resource Templates – Resource Attribute Validation
Additional validation has been added to the Resource Template and Resource Attribute panels to protect templates
that are already in use. Once a resource template has been associated with a product, it is no longer possible to
add, edit, or delete the attributes of that template, and the UI will indicate why the change is not permitted.
Standalone templates remain fully editable.
3.6. Pricing Configuration
No pricing configuration screens have been added or changed as part of the CMP 8.21 release.
3.7. SOAP Web Services
No SOAP Web Services have been added or changed as part of the CMP 8.21 release.
3.8. RESTful Web Services
3.8.1. TMF Product Ordering – Orders By Account
The Get Product Order List API has been enhanced to support filtering by
account number. This allows consumers to query for a list of product orders associated with a
specific account.
3.7.2. Create Order – Package Products (Bolt-ons via Product Offerings)
The Create Order REST APIs have been enhanced to support ordering prepaid and postpaid bolt-on packages,
either as standalone offerings or as part of a bundled product offering.
This change enables channels such as the MDS Webshop to order prepaid plans that include allowances by defining a bundle
containing a prepaid price plan plus a prepaid (recurring) bolt-on. The constituent offerings within the bundle
can be configured as not sellable individually in the Product Catalogue.
-
Orders for bolt-on packages now trigger purchase bolt-on processing, introducing a link between orders and purchases.
For prepaid scenarios, prepayments are linked to orders via purchases (there is no direct order-to-payment link).
-
A CMP Payment Identifier (prepayment) can be supplied when ordering hardware or prepaid bolt-on packages.
-
The Purchases API supports:
- CMP Order Identifier + CMP Payment Identifier when hardware is ordered and prepaid, or when a bolt-on is ordered and prepaid.
- CMP Order Identifier (without payment identifier) when a bolt-on is ordered and postpaid.
-
Bolt-on ordering supports one or many subscription numbers:
- If no subscription numbers are provided, the order can create new subscriptions via existing order logic and apply the bolt-on via a purchase.
- If subscription numbers are provided, the order can process upgrades via existing order logic and apply the bolt-on via a purchase.
3.8.3. Create Subscription Order – Serial Number Products (Product Offerings)
The Create Subscription Order REST functionality has been extended to provide a complete solution for ordering
serial number products via product offerings.
Serial number products can now be configured with or without an associated warehouse, which determines when the
serial number is applied to the subscription (and therefore which activation type is used).
-
No warehouse: the serial number is applied as a changing number at order creation time and the activation type is
Immediate.
-
Warehouse associated: an order request is generated for the warehouse and the serial number is applied as a
changing number at Order Dispatch or Customer Activation time (based on the activation type).
Managed serial numbers
-
Where the product offering attributes specify criteria for a managed serial number, the selection process validates that the
number is eligible (including management status and allocation rules), and updates the managed serial number status to reflect it as selected.
-
If a valid serial number cannot be selected, the order is moved to an Error state.
Number change rules and event processing
-
A valid Number Change Rule is required for the serial number(s) being ordered. If no applicable rule exists, the order is moved to an
Error state.
-
When multiple serial number products exist in an order, a single number change event is generated for the collection of serial numbers
(not one per product), and is processed according to the activation precedence rule:
Immediate is trumped by Order Dispatch, which is trumped by Customer Activation.
-
Where a price plan and one or more serial number products are ordered together, the order generates a Tariff Change or Connection
event (depending on whether a subscription is associated with the order). In this case, a number change event is not generated and the event is
processed using the same activation precedence rule once all serial numbers have been applied as changing numbers.
If multiple serial numbers require Customer Activation, they can be supplied together in a single
Activate Subscription REST request.
3.9. Integration Adapters
3.9.1. CXP Extract - Invoice Line SERVICE_TYPE Description
In the invoice_line.dat extract file produced for CXP, the SERVICE_TYPE column is now populated with the
service code description, rather than the service group code description.
3.10. NetEngage Adapters
No changes have been made to the NetEngage adapters as part of the CMP 8.21 release.
3.11. UK-specific Adapters
No changes have been made to the the UK=specific adapters as part of the CMP 8.21 release.
5.1. Product Documentation
The product documentation is available online on the documentation portal. This online portal requires authorised access, which can be obtained by contacting MDS Global support. The documentation is also available as downloadable PDFs as follows:
- Installation Guide
- Technical Architecture
- CMP Overview
- Documentation Overview
- System Administration Guide
- Security Guide
- AgentView Function Security Guide
- Operational Overview
- Business Configuration Overview
- Billing Functionality Guide
- Communications Functionality and Configuration Guide
- Propositions Functionality and Configuration Guide
- Payments Functionality Guide
- Extracts Guide
- Purge Guide
- Standard Reporting
- Batch Jobs and JSON Schemas Guide
- RESTful Web Services API Guide
- SOAP Web Services Semantics Guide
- Business Configuration RESTful Web Services API Guide
- Glossary
Product documentation PDFs and changes in CMP 8.21:
| Document |
Version |
Document Changes |
| AgentView Function Security Guide |
1.0 |
The Order Summary screen has been updated to include the new product offerings panel in the AgentView Function Security Guide for CMP 8.21. |
| Batch Jobs and JSON Schemas Guide |
1.0 |
The Batch Jobs and JSON Schemas Guide has been updated to include the changes to the jobs and daemons highlighted above. |
| Billing Functionality Guide |
1.0 |
There are no updates to the Billing Functionality Guide as part of CMP 8.21. |
| Business Configuration Overview |
1.0 |
Updated the Network topic to include the serial number prefixes function. |
| Business Configuration RESTful Web Services API Guide |
1.0 |
There are no updates to the Business Configuration RESTful web services guide as part of CMP 8.21. |
| CMP Overview |
1.0 |
There are no updates to the CMP Overview as part of CMP 8.21. |
| Communications Functionality and Configuration Guide |
1.0 |
There are no updates to the Communications Functionality and Configuration Guide as part of CMP 8.21. |
| Documentation Overview |
1.0 |
There are no updates to the Documentation Overview as part of CMP 8.21. |
| Extracts Guide |
1.0 |
There are no updates to the Extracts Guide as part of CMP 8.21. |
| Glossary |
1.0 |
There are no updates to the Glossary as part of CMP 8.21. |
| Installation Guide |
1.0 |
Added a topic on installing a cached version of CMP. |
| Operational Overview |
1.0 |
Added a Teams topic to the System Administration section, and updated the Network Requests topic with the new Update function that allows any requests that do not reach the network to be resolved. |
| Payments Functionality Guide |
1.0 |
There are no updates to the Payments Functionality Guide as part of CMP 8.21. |
| Propositions Functionality and Configuration Guide |
1.0 |
There are no updates to the Propositions Functionality and Configuration Guide as part of CMP 8.21. |
| Purge Guide |
1.0 |
There are no updates to the Purge Guide as part of CMP 8.21. |
| RESTful Web Services API Guide |
1.0 |
The REST web services guide has been updated based on the changes highlighted in section 3.7.1 above. |
| Security Guide |
1.0 |
There are no updates to the Security Guide as part of CMP 8.21. |
| SOAP Web Services Semantics Guide |
1.0 |
There are no updates to the SOAP Web Services Semantics Guide as part of CMP 8.21. |
| Standard Reporting |
1.0 |
There are no updates to the Standard Reporting Guide as part of CMP 8.21. |
| System Administration Guide |
1.0 |
There are no updates to the System Administration Guide as part of CMP 8.21. |
| Technical Architecture |
1.0 |
There are no updates to the Technical Architecture Guide as part of CMP 8.21 |
5.2. Online Documentation
Online help is available in AgentView, Business Configuration, the Administration Console, the Bulk Actions and the Pricing Configuration console. The following table summarises the current versions of the online help and the changes since CMP 8.20:
Online help versions and changes since CMP 8.20:
| Online Help |
Version |
Document Changes |
| AgentView |
1.12 |
Added a topic for the new Serial Number Search function that has been added to the Structure screen in AgentView, allowing you to search for a serial number for a subscription within a large customer structure. This is used if a customer structure has more than a page of subscriptions or has a complicated group structure.
Updated the Order Summary Panel topic with the new Product Offering panel that displays the product offering details.
|
| Business Configuration |
1.25 |
The following updates have been made to the Business Configuration help in CMP 8.21:
- Added a Prefixes topic allowing for the addition of an alphanumeric prefix for managed serial numbers, or list values for non-managed numbers.
- Topics on how to add and edit a serial number prefix have also been added.
|
| Administration Console |
1.23 |
New topics have been added for the new Number Management menu option. These topics include:
- Generating Serial Numbers, from where you create individual serial numbers, or a range of serial numbers.
- Manage Serial Numbers, allowing you to view the serial numbers available in a particular network, and allocate them to the relevant salesperson or account if required.
- View Serial Number Errors that can occur while managing serial numbers.
In addition, an Update option has been added to Network Requests to allow any requests that do not reach the network to be resolved.
|
| Pricing Configuration Console |
1.11 |
There are no updates to the Pricing Configuration Console as part of CMP 8.21. |
| Bulk Action Console |
1.15 |
There are no updates to the Bulk Action Console as part of CMP 8.21. |
| Aurora Console |
1.10 |
There are no updates to the Aurora Console as part of CMP 8.21. |
6.1. Upgrade Notes
6.1.1. Known Issues
6.1.1.1. Intermittent AgentView Login Issue
Logging into AgentView can intermittently result in an Authentication Failed, Try Again error.
This issue is under active investigation and will be resolved as soon as possible.
Workaround:
- Click Try Again, then refresh the browser tab to return to the base AgentView URL.
- When prompted with Please select an application, choose the CMP AgentView icon to proceed.
6.1.2. CMP8 Installer – Pre-install mode (performance improvement)
The CMP8 installer interacts with third-party repositories to retrieve the latest artefacts required for installation.
In some environments, these repositories may not be available during a production upgrade window, which can impact upgrade execution time
and increase operational risk.
CMP 8.21 introduces a pre-install mode within the CMP8 installer, allowing required artefacts to be downloaded locally
in advance of the main CMP8 upgrade.
- Reduced upgrade time by downloading artefacts ahead of the upgrade window.
- Removes dependency on third-party repository availability during the main CMP8 upgrade.
6.1.3. WSO2 Identity Server – Version Upgrade
CMP 8.21 includes an upgrade of the third-party WSO2 Identity Server component to version 7.1.0.
This is an internal platform upgrade within the identity and access management layer and does not introduce any functional changes.
6.1.4. REST Module – Java 21 Compatibility Refactor
The REST module has been refactored to ensure compatibility with Java 21.
6.2. Installation Configuration Tool Changes
6.2.1. Licensing inputs required by the ICT
CMP 8.21 introduces a licensing requirement for deployment. As part of this change, the Installation Configuration Tool (ICT)
has been updated to capture the licence certificate location and password required during installation.
- Licence Certificate Location – filesystem path to the generated .p12 certificate on the Ansible control node.
- Licence Password – the keystore password associated with the generated certificate.
6.3. Configuration Changes
6.3.1. WSO2 Identity Server – Data Retention Period
WSO2 can retain large volumes of session, token and audit data over time. There is no requirement to retain this data long-term, and it can grow significantly.
CMP 8.21 configures a default retention period of 1 month. Note: this functionality is only available from WSO2 7.1.0, which is included in the 8.21.0 release.
6.4. Database Changes
The following database updates are included in CMP 8.21.
6.4.1. New Tables
The following tables have been added in CMP 8.21:
- Table Product Type - This table replaces the existing Item Type table
- Table Brand Product Type - This table replaces the existing Brand Item Type table
6.4.2. Schema Changes
6.4.2.1. Additional Columns
The following table columns have been added in CMP 8.21:
- A new column, requestedOperation, has been added to the serial number management batch header table to control the execution path used by the managed number load job (load / allocate / deallocate / delete / reset).
- Table model, column productTypeCode
- Table Product Upload Interface Batch Header, column ProductTypeCode
- Table CSN0REP (Order Product), columns installmentPayment, upfrontPayment, isNonStockOrder, isAvailableForBackOrder, xRefOrderProductCode, installableProduct, isSubscriptionRelated, isSerialised, productPrice, priceMin, priceMax, productTypeCode, brandCode, modelCode, companyNumber, resourceTemplateCode, version and overrideChargingService
- Table CSQGREP (DISE Item Line), column orderProductCode
- Table Purchase, column orderId.
6.4.2.2. Amended Columns
The productType column has been renamed to typeOfProduct on the following tables:
- Purchase Product Error
- Subscription Service Purchase Product
The column isForceExpandNonSubsOrderLineItems has been renamed isForceExpandNonSubsOrderLineDetails on the CSOTREP (Warehouse) table.
6.4.3. Dropped Tables
The following tables have been dropped in CMP 8.21:
- Table Brand Item Type - this table has been replaced with the Brand Product Type table
- In addition, the following legacy tables have been deprecated as the information that would have been on these tables will be stored in alternative tables instead:
- Table CSNOREP (Item)
- Table CSQ4REP (Item Type)
- Table CSNLREP (Product Item)
- Table CSNPREP (Product Item Category Override)
- Table CSQGREP (Order Line Detail)
6.4.4. Dropped Columns
6.4.4.1. Billing Media
The following columns have been removed from the COIXREP (Billing Media) table:
- bill format invoice function
- bill format statement function
- bill format dbl function
- ices invoice function
- ices statement function
- ices dbl function
6.4.4.2. Network
The following columns have been removed from the COA5REP (Network) table:
- S1/2/3/4/5 Exit Point Program
- S1/2/3/4/5 B Check Exists
- S1/2/3/4/5 B Check Use By Date
- S1/2/3/4/5 B Check reuse by date
- S1/2/3/4/5 B Check dealer
- S1/2/3/4/5 B Check cross reference
- P1/2/3/4/5/6/7/8/9 Exit Point Program
- Third Party Selectable
- is Include in SIM Extract
- Item Type
- Directory Listing Allowed
6.5. Configuration Changes
6.5.1. Automatic Updates
As part of the upgrade to CMP 8.21 the following configuration changes have been automatically applied:
6.5.1.1. Number Management Access
Access to Number Management is automatically added to the following CMP group roles as part of the upgrade:
- Administrator (group role sabre-console-admin)
- Advanced Operations (group role sabre-console-advanced-ops)